16、Node.js RESTful API */

REST即表述性状态传递（英文：Representational State Transfer，简称REST）是Roy Fielding博士在2000年他的博士论文中提出来的一种软件架构风格。 表述性状态转移是一组架构约束条件和原则。满足这些约束条件和原则的应用程序或设计就是RESTful。需要注意的是，REST是设计风格而不是标准。REST通常基于使用HTTP，URI，和XML（标准通用标记语言下的一个子集）以及HTML（标准通用标记语言下的一个应用）这些现有的广泛流行的协议和标准。REST 通常使用 JSON 数据格式。

HTTP 方法

以下为 REST 基本架构的四个方法：

1
2
3
4
GET - 用于获取数据。
PUT - 用于添加数据。
DELETE - 用于删除数据。
POST - 用于更新或添加数据。

创建 RESTful

首先，创建一个 json 数据资源文件 users.json，内容如下：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
{
   "user1" : {
      "name" : "mahesh",
    "password" : "password1",
    "profession" : "teacher",
    "id": 1
   },
   "user2" : {
      "name" : "suresh",
    "password" : "password2",
    "profession" : "librarian",
    "id": 2
   },
   "user3" : {
      "name" : "ramesh",
    "password" : "password3",
    "profession" : "clerk",
    "id": 3
   }
}

基于以上数据，我们创建以下 RESTful API：

1
2
3
4
5
序号  URI       HTTP方法  发送内容   结果
  1   listUsers   GET     空          显示所有用户列表
  2   addUser   POST      JSON 字符串   添加新用户
  3   deleteUser  DELETE    JSON 字符串   删除用户
  4   :id       GET     空          显示用户详细信息

获取用户列表：listUsers

创建 RESTful API listUsers，用于读取用户的信息列表， server.js 文件代码如下所示：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
var express = require('express');
var app = express();
var fs = require('fs');
app.get('./listUsers', function (req, res){
  fs.readFile(__dirname + "/" + "users.Json", 'utf8', function (err, data){
    console.log(data);
    res.end(data);
  });
});
var server = app.listen(8081, function(){
  var host = server.address().address;
  var port = server.address().port;
  console.log("应用实例，访问地址为 http://%s:%s", host, port)
});

接下来执行以下命令：

1
2
node server.js 
应用实例，访问地址为 http://0.0.0.0:8081

在浏览器中访问 http://127.0.0.1:8081/listUsers，结果如下所示：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
{
   "user1" : {
      "name" : "mahesh",
      "password" : "password1",
      "profession" : "teacher",
      "id": 1
   },
   "user2" : {
      "name" : "suresh",
      "password" : "password2",
      "profession" : "librarian",
      "id": 2
   },
   "user3" : {
      "name" : "ramesh",
      "password" : "password3",
      "profession" : "clerk",
      "id": 3
   }
}

添加用户：addUser

创建 RESTful API addUser， 用于添加新的用户数据，server.js 文件代码如下所示：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
var express = require('express');
var app = express();
var fs = require('fs');
//添加的新用户数据
var user = {
  "user4" : {
      "name" : "mohit",
      "password" : "password4",
      "profession" : "teacher",
      "id": 4
  }
};
app.get('./addUser', function (req, res){
  //读取已存在的数据
  fs.readFile(__dirname + "/" + "users.Json", 'utf8', function (err, data){
    data = JSON.parse(data);
    data["user4"] = user["user4"];
    console.log(data);
    res.end(JSON.stringify(data));
  });
});
var server = app.listen(8081, function(){
  var host = server.address().address;
  var port = server.address().port;
  console.log("应用实例，访问地址为 http://%s:%s", host, port)
});

接下来执行以下命令：

1
2
node server.js 
应用实例，访问地址为 http://0.0.0.0:8081

在浏览器中访问 http://127.0.0.1:8081/addUser，结果如下所示：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
{ user1:
   { name: 'mahesh',
     password: 'password1',
     profession: 'teacher',
     id: 1 },
  user2:
   { name: 'suresh',
     password: 'password2',
     profession: 'librarian',
     id: 2 },
  user3:
   { name: 'ramesh',
     password: 'password3',
     profession: 'clerk',
     id: 3 },
  user4:
   { name: 'mohit',
     password: 'password4',
     profession: 'teacher',
     id: 4 } 
}

删除用户：deleteUser

创建 RESTful API deleteUser， 用于删除指定用户的详细信息，以下实例中，用户 id 为 2，server.js 文件代码如下所示：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
var express = require('express');
var app = express();
var fs = require('fs');
app.get('./deleteUser', function (req, res){
  //读取已存在的数据
  fs.readFile(__dirname + "/" + "users.Json", 'utf8', function (err, data){
    data = JSON.parse(data);
    delete data["user"+2];
    console.log(data);
    res.end(JSON.stringify(data));
  });
});
var server = app.listen(8081, function(){
  var host = server.address().address;
  var port = server.address().port;
  console.log("应用实例，访问地址为 http://%s:%s", host, port)
});

接下来执行以下命令：

1
2
node server.js 
应用实例，访问地址为 http://0.0.0.0:8081

在浏览器中访问 http://127.0.0.1:8081/deleteUser，结果如下所示：

1
2
3
4
5
6
7
8
9
10
11
{ user1:
   { name: 'mahesh',
     password: 'password1',
     profession: 'teacher',
     id: 1 },
  user3:
   { name: 'ramesh',
     password: 'password3',
     profession: 'clerk',
     id: 3 },
}

显示用户详情：:id(用户id)

创建 RESTful API :id（用户id）， 用于读取指定用户的详细信息，server.js 文件代码如下所示：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
var express = require('express');
var app = express();
var fs = require('fs');
app.get('./:id', function (req, res){
  //读取已存在的数据
  fs.readFile(__dirname + "/" + "users.Json", 'utf8', function (err, data){
    data = JSON.parse(data);
    var user = data["user" + req.params.id]
    console.log(user);
    res.end(JSON.stringify(user));
  });
});
var server = app.listen(8081, function(){
  var host = server.address().address;
  var port = server.address().port;
  console.log("应用实例，访问地址为 http://%s:%s", host, port)
});

接下来执行以下命令：

1
2
node server.js 
应用实例，访问地址为 http://0.0.0.0:8081

在浏览器中访问 http://127.0.0.1:8081/2，结果如下所示：

1
2
3
4
5
6
{
   "name":"suresh",
   "password":"password2",
   "profession":"librarian",
   "id":2
}